Platform Explorer / Nuxeo Platform 2023.9

Component org.nuxeo.runtime.pubsub.PubSubService

Documentation

The PubSub service allows cross-instance notifications through simple messages sent to topics.

Resolution Order

819
The resolution order represents the order in which this component has been resolved by the Nuxeo Runtime framework.
You can influence this order by adding "require" tags in your component declaration, to make sure it is resolved after another component.

Start Order

13 (Declared Start Order: -490)
The start order represents the order in which this component has been started by the Nuxeo Runtime framework.
This number is interesting to tweak if your Java component interacts with other components, and needs to be started before or after another one.
It can be changed by implementing the method "Component#getApplicationStartedOrder()" on your Java component: components are sorted according to this reference value, in increasing order.
The default value is 1000, and the repository initialization uses number 100. Negative values can also be used.

Implementation

Class: org.nuxeo.runtime.pubsub.PubSubServiceImpl

Services

Extension Points

XML Source

<?xml version="1.0"?>
<component name="org.nuxeo.runtime.pubsub.PubSubService" version="1.0">

  <documentation>
    The PubSub service allows cross-instance notifications through simple messages sent to topics.
  </documentation>

  <service>
    <provide interface="org.nuxeo.runtime.pubsub.PubSubService" />
  </service>

  <implementation class="org.nuxeo.runtime.pubsub.PubSubServiceImpl" />

  <extension-point name="configuration">
    <documentation>
      Defines the implementation of the PubSub service:
      <code>
        <provider class="org.nuxeo.runtime.pubsub.MemPubSubProvider"/>
      </code>
      The class must implement org.nuxeo.runtime.pubsub.PubSubProvider.

      This component comes with a Nuxeo Stream PubSubProvider implementation:
      <code>
        <provider class="org.nuxeo.runtime.pubsub.StreamPubSubProvider">
          <option name="logConfig">default</option>
          <option name="logName">pubsub</option>
          <option name="codec">avroBinary</option>
        </provider>
      </code>
    </documentation>

    <object class="org.nuxeo.runtime.pubsub.PubSubProviderDescriptor" />
  </extension-point>

</component>